home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
IRIX Base Documentation 1998 November
/
IRIX 6.5.2 Base Documentation November 1998.img
/
usr
/
share
/
catman
/
p_man
/
cat3
/
Vk
/
VkBackground.z
/
VkBackground
Wrap
Text File
|
1998-10-20
|
5KB
|
133 lines
VVVVkkkkBBBBaaaacccckkkkggggrrrroooouuuunnnndddd((((3333xxxx)))) VVVVkkkkBBBBaaaacccckkkkggggrrrroooouuuunnnndddd((((3333xxxx))))
NNNNAAAAMMMMEEEE
VkBackground - Support for simple work procedure-based background tasks
IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
VkCallbackObject
HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
#include <Vk/VkBackground.h>
PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
VkBackground(void);
void ~VkBackground(void);
SSSSttttaaaarrrrttttiiiinnnngggg aaaannnndddd SSSSttttooooppppppppiiiinnnngggg
void start(void);
void stop(void);
PPPPRRRROOOOTTTTEEEECCCCTTTTEEEEDDDD PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
virtual Boolean timeSlice(void);
CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
VkBackground is an abstract class that provides a simple C++
interface to handling background tasks based on Xt work procedures
(functions that are called whenever there are no events pending in
the application's event queue). VkBackground handles the details of
registering a work procedure and provides a convenient way to
maintain state between calls to the work procedure.
DDDDEEEERRRRIIIIVVVVIIIINNNNGGGG SSSSUUUUBBBBCCCCLLLLAAAASSSSSSSSEEEESSSS
The VkBackground class is intended to be subclassed. Derived classes
must override the _t_i_m_e_S_l_i_c_e() member function which behaves just
like an Xt work procedure. This member function is called whenever
no events are pending in the application's event queue. It is
expected to perform a small amount of work and return quickly. The
function must return TRUE if the class has completed its task is
done, or FALSE if the member function should be called again.
The primary for using this class instead of using a work procedure
directly is the ability to store state in class data members between
calls to the _t_i_m_e_S_l_i_c_e() function.
PPPPaaaaggggeeee 1111
VVVVkkkkBBBBaaaacccckkkkggggrrrroooouuuunnnndddd((((3333xxxx)))) VVVVkkkkBBBBaaaacccckkkkggggrrrroooouuuunnnndddd((((3333xxxx))))
FUNCTION DESCRIPTIONS
ttttiiiimmmmeeeeSSSSlllliiiicccceeee(((())))
virtual Boolean timeSlice(void);
Called whenever no events are pending in the application's event
queue. This function must return quickly and return a value of TRUE
if the class has completed its task and the member function should
not be called again, or FALSE if it should be called again at the
next possible time.
VVVVkkkkBBBBaaaacccckkkkggggrrrroooouuuunnnndddd(((())))
VkBackground(void);
Initialize a VkBackground object. The constructor does _n_o_t start the
work procedure.
~~~~VVVVkkkkBBBBaaaacccckkkkggggrrrroooouuuunnnndddd(((())))
void ~VkBackground(void);
Free all storage associated with a VkBackground object. If this
object's work procedure is currently active, the destructor removes
it.
ssssttttaaaarrrrtttt(((())))
void start(void);
Start the background task by installing a work procedure.
ssssttttoooopppp(((())))
void stop(void);
Stop the background task by removing any currently installed work
procedure.
IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
SSSSEEEEEEEE AAAALLLLSSSSOOOO
_V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
_T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
_T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
_T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
PPPPaaaaggggeeee 2222